Skip to content

feat(api): add Django Ninja with releng releases endpoint#674

Open
inglor wants to merge 2 commits into
archlinux:masterfrom
inglor:openapi
Open

feat(api): add Django Ninja with releng releases endpoint#674
inglor wants to merge 2 commits into
archlinux:masterfrom
inglor:openapi

Conversation

@inglor
Copy link
Copy Markdown
Member

@inglor inglor commented May 9, 2026

Introduces the api/ Django app with django-ninja==1.6.2. Mounts NinjaAPI at /api/ with OpenAPI schema at /api/openapi.json and Swagger UI at /api/docs/. Implements the first route:

GET /api/v1/releng/releases/ -> ReleasesSchema

Pydantic schema mirrors ReleaseJSONEncoder output. 10 tests covering endpoint behaviour and OpenAPI schema contract.

Add decorator for deprecation HTTP header RFC 8594

Closes part of #199.

@inglor inglor requested a review from jelly May 9, 2026 06:46
@inglor inglor self-assigned this May 9, 2026
@inglor inglor force-pushed the openapi branch 2 times, most recently from 0da8066 to 110934d Compare May 9, 2026 07:18
Copy link
Copy Markdown
Member

@jelly jelly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note, that you'll need a rebase locally if you pulled stuff from master and run django migrations due to svn_root removal.

This is super interesting, especially since we want to be allow users to sign off packages using an API or marking packages from a todolist.

For that we need authentication which ninja seems to support. So I would be interested in experimenting with that.

Comment thread api/schemas/releng.py Outdated
inglor added 2 commits May 14, 2026 20:08
Introduces the api/ Django app with django-ninja==1.6.2. Mounts
NinjaAPI at /api/ with OpenAPI schema at /api/openapi.json and
Swagger UI at /api/docs/. Implements the first route:

  GET /api/v1/releng/releases/ -> ReleasesSchema

Pydantic schema mirrors ReleaseJSONEncoder output. 10 tests
covering endpoint behaviour and OpenAPI schema contract.

Closes part of archlinux#199.

Signed-off-by: Leonidas Spyropoulos <artafinde@archlinux.org>
Add `deprecated_json_endpoint` decorator in `api/deprecation.py` (RFC 8594).
Apply to `releng/views.py` `releases_json` - response now includes
`Deprecation: true` and `Link: </api/v1/releng/releases/>; rel="successor-version"`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants